SetRow(int,byte[],int,int) Method

Summary

Copies one or more rows of image data to this RasterImage.

Syntax

Objective-C

C++

Java

public int SetRow( 
   int row, 
   byte[] buffer, 
   int bufferIndex, 
   int bufferCount 
)

Public Overloads Function SetRow( _ 
   ByVal row As Integer, _ 
   ByVal buffer() As Byte, _ 
   ByVal bufferIndex As Integer, _ 
   ByVal bufferCount As Integer _ 
) As Integer

- (NSInteger)setRow:(NSInteger)row  
             buffer:(const unsigned char *)buffer  
        bufferCount:(unsigned long)count  
              error:(NSError **)error

public long setRow( 
  int row,  
  byte[] buffer,  
  int bufferIndex,  
  long bufferCount 
)

public: 
int SetRow(  
   int row, 
   array<byte>^ buffer, 
   int bufferIndex, 
   int bufferCount 
)

Parameters

row
The number of the row to update. The first row is 0, and the last row is 1 less than the image height.

buffer
Buffer containing the image data. The data is copied exactly as it is stored in the buffer. The buffer should contain uncompressed data regardless of whether the image is compressed or not.

bufferIndex
The zero-based index into the buffer where the set operation should start.

bufferCount
Number of bytes to set. Use the BytesPerLine property of this RasterImage to determine the byte count of each line.

Return Value

The number of bytes copied.

Remarks

The image memory must be locked when you use this method. Normally, you can call Access to lock the memory before starting an operation that uses this method. Then call Release when the operation is finished.

You can use the BitsPerPixel property of the image to determine the number of bytes to set the bufferCount parameter. If the image is 8-bit then each byte is an index to the palette. If the image is a 24-bit image, then each three bytes represents one pixel element. Color order is determined by the Order property of the RasterImage object. This value can be RasterByteOrder.Rgb, RasterByteOrder.Bgr, or RasterByteOrder.Romm.

Note: To calculate the correct size for a single row of image data:

Windows-based platforms: (((Width * BitsPerPixel) + 31) >> 3)) & ~3
Unix-based platforms (Linux, Android, OSX, iOS): (((Width * BitsPerPixel) + 7) / 8)

RasterByteOrder.Gray is only valid for 12 and 16-bit grayscale images. Support for 12 and 16-bit grayscale images is only available in the Document/Medical Imaging editions.

For more information, refer to Introduction to Image Processing With LEADTOOLS.

Example

For an example, refer to GetRow.

Requirements

Target Platforms